<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Firmata firmware for Arduino: FirmataParser.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Firmata firmware for Arduino
   </div>
   <div id="projectbrief">Firmata is a protocol for communicating with microcontrollers from software on a host computer</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">FirmataParser.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">  FirmataParser.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">  Copyright (c) 2006-2008 Hans-Christoph Steiner.  All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">  Copyright (C) 2009-2016 Jeff Hoefs.  All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">  This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">  modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">  License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">  version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">  See file LICENSE.txt for further informations on licensing terms.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#ifndef FirmataParser_h</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#define FirmataParser_h</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#if defined(__cplusplus) &amp;&amp; !defined(ARDUINO)</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">  #include &lt;cstddef&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">  #include &lt;cstdint&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">  #include &lt;stddef.h&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">  #include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">namespace </span>firmata {</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classfirmata_1_1_firmata_parser.html">   27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classfirmata_1_1_firmata_parser.html">FirmataParser</a></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;{</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    <span class="comment">/* callback function types */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="keyword">typedef</span> void (*callbackFunction)(<span class="keywordtype">void</span> * context, uint8_t command, uint16_t value);</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keyword">typedef</span> void (*dataBufferOverflowCallbackFunction)(<span class="keywordtype">void</span> * context);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="keyword">typedef</span> void (*stringCallbackFunction)(<span class="keywordtype">void</span> * context, <span class="keyword">const</span> <span class="keywordtype">char</span> * c_str);</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <span class="keyword">typedef</span> void (*sysexCallbackFunction)(<span class="keywordtype">void</span> * context, uint8_t command, <span class="keywordtype">size_t</span> argc, uint8_t * argv);</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keyword">typedef</span> void (*systemCallbackFunction)(<span class="keywordtype">void</span> * context);</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="keyword">typedef</span> void (*versionCallbackFunction)(<span class="keywordtype">void</span> * context, <span class="keywordtype">size_t</span> sv_major, <span class="keywordtype">size_t</span> sv_minor, <span class="keyword">const</span> <span class="keywordtype">char</span> * firmware);</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <a class="code" href="classfirmata_1_1_firmata_parser.html#ac8c388b593a00e88856646712beae68b">FirmataParser</a>(uint8_t * dataBuffer = (uint8_t *)NULL, <span class="keywordtype">size_t</span> dataBufferSize = 0);</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="comment">/* serial receive handling */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a754c97b890b7fd66c8d953a3e615acbf">parse</a>(uint8_t value);</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a67902b70695eaf0cf8f7b06175ca3902">isParsingMessage</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a8fbe143ddb428a97c00a15993c31a516">setDataBufferOfSize</a>(uint8_t * dataBuffer, <span class="keywordtype">size_t</span> dataBufferSize);</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="comment">/* attach &amp; detach callback functions to messages */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a2a472a925ed7e626ed36dee94ceae45e">attach</a>(uint8_t command, callbackFunction newFunction, <span class="keywordtype">void</span> * context = NULL);</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a2a472a925ed7e626ed36dee94ceae45e">attach</a>(dataBufferOverflowCallbackFunction newFunction, <span class="keywordtype">void</span> * context = NULL);</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a2a472a925ed7e626ed36dee94ceae45e">attach</a>(uint8_t command, stringCallbackFunction newFunction, <span class="keywordtype">void</span> * context = NULL);</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a2a472a925ed7e626ed36dee94ceae45e">attach</a>(uint8_t command, sysexCallbackFunction newFunction, <span class="keywordtype">void</span> * context = NULL);</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a2a472a925ed7e626ed36dee94ceae45e">attach</a>(uint8_t command, systemCallbackFunction newFunction, <span class="keywordtype">void</span> * context = NULL);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a2a472a925ed7e626ed36dee94ceae45e">attach</a>(uint8_t command, versionCallbackFunction newFunction, <span class="keywordtype">void</span> * context = NULL);</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a7cd707386c0807bee733a3e27d161c7d">detach</a>(uint8_t command);</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classfirmata_1_1_firmata_parser.html#a7cd707386c0807bee733a3e27d161c7d">detach</a>(dataBufferOverflowCallbackFunction);</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="comment">/* input message handling */</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keywordtype">bool</span> allowBufferUpdate;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    uint8_t * dataBuffer; <span class="comment">// multi-byte data</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keywordtype">size_t</span> dataBufferSize;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    uint8_t executeMultiByteCommand; <span class="comment">// execute this after getting multi-byte data</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    uint8_t multiByteChannel; <span class="comment">// channel data for multiByteCommands</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keywordtype">size_t</span> waitForData; <span class="comment">// this flag says the next serial input will be data</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="comment">/* sysex */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keywordtype">bool</span> parsingSysex;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <span class="keywordtype">size_t</span> sysexBytesRead;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="comment">/* callback context */</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keywordtype">void</span> * currentAnalogCallbackContext;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keywordtype">void</span> * currentDigitalCallbackContext;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="keywordtype">void</span> * currentReportAnalogCallbackContext;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="keywordtype">void</span> * currentReportDigitalCallbackContext;</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keywordtype">void</span> * currentPinModeCallbackContext;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keywordtype">void</span> * currentPinValueCallbackContext;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keywordtype">void</span> * currentReportFirmwareCallbackContext;</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordtype">void</span> * currentReportVersionCallbackContext;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <span class="keywordtype">void</span> * currentDataBufferOverflowCallbackContext;</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <span class="keywordtype">void</span> * currentStringCallbackContext;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <span class="keywordtype">void</span> * currentSysexCallbackContext;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keywordtype">void</span> * currentSystemResetCallbackContext;</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="comment">/* callback functions */</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    callbackFunction currentAnalogCallback;</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    callbackFunction currentDigitalCallback;</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    callbackFunction currentReportAnalogCallback;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    callbackFunction currentReportDigitalCallback;</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    callbackFunction currentPinModeCallback;</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    callbackFunction currentPinValueCallback;</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    dataBufferOverflowCallbackFunction currentDataBufferOverflowCallback;</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    stringCallbackFunction currentStringCallback;</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    sysexCallbackFunction currentSysexCallback;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    versionCallbackFunction currentReportFirmwareCallback;</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    systemCallbackFunction currentReportVersionCallback;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    systemCallbackFunction currentSystemResetCallback;</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="comment">/* private methods ------------------------------ */</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <span class="keywordtype">bool</span> bufferDataAtPosition(<span class="keyword">const</span> uint8_t data, <span class="keyword">const</span> <span class="keywordtype">size_t</span> pos);</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    <span class="keywordtype">size_t</span> decodeByteStream(<span class="keywordtype">size_t</span> bytec, uint8_t * bytev);</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <span class="keywordtype">void</span> processSysexMessage(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    <span class="keywordtype">void</span> systemReset(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;};</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;} <span class="comment">// firmata</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160; </div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FirmataParser_h */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassfirmata_1_1_firmata_parser_html_a67902b70695eaf0cf8f7b06175ca3902"><div class="ttname"><a href="classfirmata_1_1_firmata_parser.html#a67902b70695eaf0cf8f7b06175ca3902">firmata::FirmataParser::isParsingMessage</a></div><div class="ttdeci">bool isParsingMessage(void) const</div><div class="ttdef"><b>Definition:</b> FirmataParser.cpp:176</div></div>
<div class="ttc" id="aclassfirmata_1_1_firmata_parser_html_ac8c388b593a00e88856646712beae68b"><div class="ttname"><a href="classfirmata_1_1_firmata_parser.html#ac8c388b593a00e88856646712beae68b">firmata::FirmataParser::FirmataParser</a></div><div class="ttdeci">FirmataParser(uint8_t *dataBuffer=(uint8_t *) NULL, size_t dataBufferSize=0)</div><div class="ttdef"><b>Definition:</b> FirmataParser.cpp:33</div></div>
<div class="ttc" id="aclassfirmata_1_1_firmata_parser_html"><div class="ttname"><a href="classfirmata_1_1_firmata_parser.html">firmata::FirmataParser</a></div><div class="ttdef"><b>Definition:</b> FirmataParser.h:27</div></div>
<div class="ttc" id="aclassfirmata_1_1_firmata_parser_html_a2a472a925ed7e626ed36dee94ceae45e"><div class="ttname"><a href="classfirmata_1_1_firmata_parser.html#a2a472a925ed7e626ed36dee94ceae45e">firmata::FirmataParser::attach</a></div><div class="ttdeci">void attach(uint8_t command, callbackFunction newFunction, void *context=NULL)</div><div class="ttdef"><b>Definition:</b> FirmataParser.cpp:216</div></div>
<div class="ttc" id="aclassfirmata_1_1_firmata_parser_html_a7cd707386c0807bee733a3e27d161c7d"><div class="ttname"><a href="classfirmata_1_1_firmata_parser.html#a7cd707386c0807bee733a3e27d161c7d">firmata::FirmataParser::detach</a></div><div class="ttdeci">void detach(uint8_t command)</div><div class="ttdef"><b>Definition:</b> FirmataParser.cpp:337</div></div>
<div class="ttc" id="aclassfirmata_1_1_firmata_parser_html_a8fbe143ddb428a97c00a15993c31a516"><div class="ttname"><a href="classfirmata_1_1_firmata_parser.html#a8fbe143ddb428a97c00a15993c31a516">firmata::FirmataParser::setDataBufferOfSize</a></div><div class="ttdeci">int setDataBufferOfSize(uint8_t *dataBuffer, size_t dataBufferSize)</div><div class="ttdef"><b>Definition:</b> FirmataParser.cpp:189</div></div>
<div class="ttc" id="aclassfirmata_1_1_firmata_parser_html_a754c97b890b7fd66c8d953a3e615acbf"><div class="ttname"><a href="classfirmata_1_1_firmata_parser.html#a754c97b890b7fd66c8d953a3e615acbf">firmata::FirmataParser::parse</a></div><div class="ttdeci">void parse(uint8_t value)</div><div class="ttdef"><b>Definition:</b> FirmataParser.cpp:81</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
